Skip to content

fix: replace hardcoded edX with platformName in basicBannerTitle message#2711

Merged
bradenmacdonald merged 2 commits intoopenedx:masterfrom
mitodl:anas/fix-platform-name
Nov 28, 2025
Merged

fix: replace hardcoded edX with platformName in basicBannerTitle message#2711
bradenmacdonald merged 2 commits intoopenedx:masterfrom
mitodl:anas/fix-platform-name

Conversation

@Anas12091101
Copy link
Copy Markdown
Contributor

@Anas12091101 Anas12091101 commented Nov 28, 2025 •
edited
Loading

Description

This PR replaces the hardcoded "edX" with platformName in the basicBannerTitle message.

Useful information to include:

  • Which user roles will this change impact? Course Author
  • Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).
Screenshot 2025-11-28 at 12 50 39 PM

Supporting information

https://github.com/mitodl/hq/issues/9362

Testing instructions

  • Add the following settings to your edx-platform instance to display the banner:
MKTG_URLS = {
    "ROOT": "https://your-marketing-site-url"
}
FEATURES["ENABLE_MKTG_SITE"] = True
  • Verify that the basicbannerTItle reflects the platform name instead of edX on the Scheduling & Details page

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Avoid propTypes and defaultProps in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Nov 28, 2025

Thanks for the pull request, @Anas12091101!

This repository is currently maintained by @bradenmacdonald.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 28, 2025
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Nov 28, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Nov 28, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.86%. Comparing base (0c1554b) to head (88e2ec1).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff            @@
##           master    #2711    +/-   ##
========================================
  Coverage   94.86%   94.86%            
========================================
  Files        1233     1233            
  Lines       27940    27940            
  Branches     6337     6150   -187     
========================================
  Hits        26505    26505            
- Misses       1364     1377    +13     
+ Partials       71       58    -13

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Anas12091101 Anas12091101 moved this from Needs Triage to Ready for Review in Contributions Nov 28, 2025
@bradenmacdonald
Copy link
Copy Markdown
Contributor

bradenmacdonald commented Nov 28, 2025

Testing instructions

  • Verify that the basicbannerTItle reflects the platform name instead of edX on the Scheduling & Details page

How do I get the banner to appear? I don't see it on a normal course's "Schedule & Details" page.

@Anas12091101
Copy link
Copy Markdown
Contributor Author

Anas12091101 commented Nov 28, 2025

I'm sorry for the oversight. I should have included this in the testing instructions. Please add the following settings to your edx-platform instance to display the banner:

MKTG_URLS = {
    "ROOT": "https://your-marketing-site-url"
}
FEATURES["ENABLE_MKTG_SITE"] = True

bradenmacdonald
bradenmacdonald approved these changes Nov 28, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM.

@bradenmacdonald bradenmacdonald merged commit f9e09f0 into openedx:master Nov 28, 2025
7 checks passed
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Nov 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bradenmacdonald bradenmacdonald bradenmacdonald approved these changes

Assignees

No one assigned

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Anas12091101 @openedx-webhooks @bradenmacdonald